Get Bulk Send List By ID
AutomatR.DocuSign.Activities.GetBulkSendListByID
The "Get Bulk Send List By ID" activity in AutomatR is part of the DocuSign Bulk Send activities package, allowing users to retrieve a specific Bulk Send List from the DocuSign API using its Bulk Send List ID. This activity is useful for obtaining detailed information about a bulk send list for further processing in automated workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Bulk Send List ID | The bulk send list ID. This property is created after you post a new bulk send list. String variables containing the bulk send list ID. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Get Bulk Send List By ID" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Response | Returns the bulk sending list. Variables of relevant types (e.g., BulkSendingList) to store the bulk send list information. |
How to use:
- Drag and drop the "Get Bulk Send List By ID" activity onto the workflow.
- Configure the properties by providing the necessary input values, such as the bulk send list ID.
- Optionally, configure the delay.
- Execute the workflow to retrieve information about the specified bulk send list.
Important Note:
- Ensure that the "Get Bulk Send List By ID" activity is used within the scope of the "DocuSign Scope" activity.
Example: Consider an example where the "Get Bulk Send List By ID" activity is used to retrieve information about a specific bulk send list:
Get Bulk Send List By ID:
Bulk Send List ID: "bulkSendListId"
Delay: 5
Response: bulkSendListInfo
In this example, the activity retrieves detailed information about the bulk send list with the specified ID. The obtained information is stored in the variable "bulkSendListInfo" for further processing in the workflow.